ValuesScreen

The ValuesScreen business rule defines a field presentation for OIPA's Values screen. The OIPA Values screen invokes a valuation which includes performing the PolicyValues business rule. PolicyValues contains math variables which are the data source for the field presentation defined by the <PolicyValues> element structure in this rule. The rule is defined within a Policy context that must be overridden by Product or Plan or Product and State or Plan and State.

In addition, the ValuesScreen business rule can also perform the following:

define the default valuation date upon screen load.
display fund valuation details
display charts for fund allocations and assets.

ValuesScreen Elemetns and Attributes
Element	Attribute	Parent Element	Description	Element / Attribute Values
<ValuesScreen>			Required: This element is the parent/root element for the rule.
<DefaultValuationDate>			Optional: This element defines the initial valuation date that is set on Values screen's loading. By default, the valuation date is set to the current system date. If the <DefaultValuationDate> element is not included in this Business Rule or if the TYPE attribute is omitted in this element, then the current system date will be the default valuation date,	no value this is applicable with TYPE attribute is SystemDate or TYPE attribute is not configured sql statement this is applicable only when TYPE attribute is SQL or SQLXPATH
	TYPE	<DefaultValuationDate>	Optional: This attribute indicates a source for the default valuation date.	SystemDate default data source is the current system date parent element should have no value SQL parent element's value should be a SQL statement that returns a date value SQLXPATH parent element's value should be a SQL statement that returns XMLXPATH attribute is required
	XPATH	<DefaultValuationDate>	Optional: This attribute is applicable only when TYPE attribute is SQLXPATH. It will parse the XML in order to access a specific value from the parent element's SQL result. Any date value is valid.	xpath statement
<PolicyValues>		<ValuesScreen>	Required: This element's structure defines the presentation of data from the PolicyValues business rule onto the Values Screen. This presentation is view only and will not allow users to modify.
	VALUEFINANCIALENTRY	<PolicyValues>	Optional: This attribute allows calculation of the Financial Entry calculations and math that can be added to the PolicyValues variable results. IsValueFinancialEntry system context value is assigned the value of "Yes".	No default Financial Entry calculations and math are not performed. Yes Financial Entry calculations and math are performed.
<Fields>		<PolicyValues>	Required: This element's structure defines field presentation for the screen. See Fields Element page under Common Elements. The common <Field> element's data source is restricted to math variables from the Plan's PolicyValues business rule of all data types of TEXT, CURRENCY, DECIMAL, INTEGER and DATE and the Policy's fields (syntax Policy:[fieldname]). All common field datatypes can be configured.
<FundDetails>		<ValuesScreen>	Required: The element defines a grid of fund and fund valuation detail values. Fund Name and Cash Value columns are always displayed. By default, all funds in the Policy's valuation present data in the grid.
<Exclude>		<FundDetails>	Optional: This element provides a list of funds to exclude from the fund details grid.
	CASHVALUEZERO	<Exclude>	Optional: This attribute places a restriction when the funds in the exclusion list are excluded.	No default Funds in the exclusion list are excluded regardless of their cash values. Yes Funds in the exclusion list are excluded only when their cash value is zero.
<Fund>		<Exclude>	Required, Repeatable: This element provides a fund name that may be excluded from the Fund Details grid. The element is repeated to name multiple funds under the parent element.	literal valid fund name
<Include>		<FundDetails>	Optional: This element provides a list of funds to include in the fund details grid.
<Fund>		<Include>	Required, Repeatable: This element provides a fund name that may be included in the Fund Details grid. The element is repeated to name multiple funds under the parent element.	literal valid fund name
<Columns>		<FundDetails>	Optional: This element defines a data grid to present each fund's valuation information as a set of columns. "Fund Name" and "Cash Value" are constant columns presented in the left most columns in the grid. Columns defined in this structure will present to the right of these constant columns.
<Column>		<Columns>	Required, Repeatable: This element defines a single column to present in the data grid.
	ALIGN		Optional: This attribute provides a position for the column's content.	LEFT default positions the column's content towards the left border of the column CENTER positions the column's content in the center of the column RIGHT positions the column's content towards the right border of the column
<Name>		<Column>	Required: This element provides the name of the system variable whose value populates the cells of this column. Included in the list of system variables is any fund level mapped field defined in ValuationFields business rule and math variables defined in the PolicyValues business rule.	Principal Gain NetGain Units UnitValue Bucket PrimaryCostBasis TaxableGain FreeAmount MVAAmount GuaranteedAmount fund level mapped fields variable
<Display>		<Column>	Required: This element provides the column's header text.	literal
<DataType>		<Column>	Optional: This element provides the data type for the data being presented. The system knows the source data's datatype and so this element is optional. However, this can be used to modify presentation of numeric datatypes and money datatypes to present them with or without currency codes. Example, a money value can be presented as a decimal value with no currency code or a decimal value can be presented with a currency code that matches the fund's currency code. Another example, a decimal or integer value can be presented as a percent.	Date Decimal Integer Money Percent Text
<Graphs>		<PolicyValues>	Optional: This element describes the pie charts for the Assets and Allocations properties.
	ASSETS	<Graphs>	Optional: This attribute defines presentation of the Assets pie chart.	No default the asset pie chart will not be presented Yes the asset pie chart will be presented
	ALLOCATIONS	<Graphs>	Optional: This attribute defines presentation of the Allocations pie chart.	No default the allocations pie chart will not be presented Yes the asset pie chart will be presented

XML Schema

<ValuesScreen>
    <DefaultValuationDate TYPE="SQL">[sql]</DefaultValuationDate>
    <DefaultValuationDate TYPE="SQLPATH" XPATH="[xpath]">[sql]</DefaultValuationDate>
    <DefaultValuationDate TYPE="SystemDate"></DefaultValuationDate>
    <PolicyValues VALUEFINANCIALENTRY="[No | Yes]">
        <Fields>
            <Field>
                <Name>[variable]</Name>
                <Display>[literal]</Display>
                <DataType>[Blank | Check | Client | Combo | Date | Decimal | Identifier | Integer | Label | Line | Message | Money | Percent | Radio | Text | TextArea | Title]</DataType>
            </Field>
            <Field>...</Field>
        </Fields>
    </PolicyValues>
    <FundDetails>
        <Exclude CASHVALUEZERO="[No | Yes]">
            <Fund>[fund name]</Fund>
            <Fund>...</Fund>
        </Exclude>
        <Include>
            <Fund>[fund name]</Fund>
            <Fund>...</Fund>
        </Include>
        <Columns>
            <Column ALIGN="[LEFT | CENTER | RIGHT]">
                <Name>[Principal | Gain | NetGain | Units | UnitValue | Bucket | PrimaryCostBasis | TaxableGain | FreeAmount | MVAAmount | GuaranteedAmount | [fund mapped fields] | variable]</Name>
                <Display>[literal]</Display>
                <DataType>[Date | Decimal | Integer | Money | Percent | Text]</DataType>
            </Column>
            <Column>...</Column>
        </Columns>
    </FundDetails>
    <Graphs ALLOCATIONS="[No | Yes]" ASSETS="[No | Yes]" />
</ValuesScreen>

XML Example

<ValuesScreen>
    <PolicyValues>
        <Fields>
            <Field>
                <Name>TotalAccountValueUSDMV</Name>
                <Display>Policy Cash Value</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>Filler</Name>
                <Display/>
                <DataType>Blank</DataType>
            </Field>
            <Field>
                <Name>Line</Name>
                <DataType>Line</DataType>
            </Field>
            <Field>
                <Name>IULInterimHoldingFundValueUSDMV</Name>
                <Display>Interim Holding Fund Value</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>IULFixedTermFundValueUSDMV</Name>
                <Display>Fixed Term Fund Value</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>Line</Name>
                <DataType>Line</DataType>
            </Field>
            <Field>
                <Name>IULStrategy1FundValueUSDMV</Name>
                <Display>Indexed Strategy I Fund Value</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>Filler</Name>
                <Display/>
                <DataType>Blank</DataType>
            </Field>
            <Field>
                <Name>IULStrategy1Bucket1ValueUSDMV</Name>
                <Display>Bucket 1 Value</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>IULStrategy1Bucket2ValueUSDMV</Name>
                <Display>Bucket 2 Value</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>IULStrategy1Bucket3ValueUSDMV</Name>
                <Display>Bucket 3 Value</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>IULStrategy1Bucket4ValueUSDMV</Name>
                <Display>Bucket 4 Value</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>IULStrategy1Bucket5ValueUSDMV</Name>
                <Display>Bucket 5 Value</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>IULStrategy1Bucket6ValueUSDMV</Name>
                <Display>Bucket 6 Value</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>IULStrategy1Bucket7ValueUSDMV</Name>
                <Display>Bucket 7 Value</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>IULStrategy1Bucket8ValueUSDMV</Name>
                <Display>Bucket 8 Value</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>IULStrategy1Bucket9ValueUSDMV</Name>
                <Display>Bucket 9 Value</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>IULStrategy1Bucket10ValueUSDMV</Name>
                <Display>Bucket 10 Value</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>IULStrategy1Bucket11ValueUSDMV</Name>
                <Display>Bucket 11 Value</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>IULStrategy1Bucket12ValueUSDMV</Name>
                <Display>Bucket 12 Value</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>Line</Name>
                <DataType>Line</DataType>
            </Field>
            <Field>
                <Name>IULStrategy2FundValueUSDMV</Name>
                <Display>Indexed Strategy II Fund Value</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>Filler</Name>
                <Display/>
                <DataType>Blank</DataType>
            </Field>
            <Field>
                <Name>IULStrategy2Bucket1ValueUSDMV</Name>
                <Display>Bucket 1 Value</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>IULStrategy2Bucket2ValueUSDMV</Name>
                <Display>Bucket 2 Value</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>IULStrategy2Bucket3ValueUSDMV</Name>
                <Display>Bucket 3 Value</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>IULStrategy2Bucket4ValueUSDMV</Name>
                <Display>Bucket 4 Value</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>IULStrategy2Bucket5ValueUSDMV</Name>
                <Display>Bucket 5 Value</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>IULStrategy2Bucket6ValueUSDMV</Name>
                <Display>Bucket 6 Value</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>IULStrategy2Bucket7ValueUSDMV</Name>
                <Display>Bucket 7 Value</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>IULStrategy2Bucket8ValueUSDMV</Name>
                <Display>Bucket 8 Value</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>IULStrategy2Bucket9ValueUSDMV</Name>
                <Display>Bucket 9 Value</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>IULStrategy2Bucket10ValueUSDMV</Name>
                <Display>Bucket 10 Value</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>IULStrategy2Bucket11ValueUSDMV</Name>
                <Display>Bucket 11 Value</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>IULStrategy2Bucket12ValueUSDMV</Name>
                <Display>Bucket 12 Value</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>Line</Name>
                <DataType>Line</DataType>
            </Field>
            <Field>
                <Name>IULStandardLoanFundValueUSDMV</Name>
                <Display>Standard Loan Fund Value</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>IULStandardLoanCreditFundValueUSDMV</Name>
                <Display>Standard Loan Credit Fund Value</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>IULPreferredLoanFundValueUSDMV</Name>
                <Display>Preferred Loan Fund Value</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>IULPreferredLoanCreditFundValueUSDMV</Name>
                <Display>Preferred Loan Credit Fund Value</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>Line</Name>
                <DataType>Line</DataType>
            </Field>
            <Field>
                <Name>IULCVATDCVFundValueUSDMV</Name>
                <Display>CVAT DCV Fund Value</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>IULCVATDCVDeficitFundValueUSDMV</Name>
                <Display>CVAT DCV Deficit Fund Value</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>IULShadowGuaranteeFundValueUSDMV</Name>
                <Display>Shadow Guarantee Fund Value</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>IULShadowGuaratneeDeficitFundValueUSDMV</Name>
                <Display>Shadow Guarantee Deficit Fund Value</Display>
                <DataType>Money</DataType>
            </Field>
            <Field>
                <Name>IULBasePolicyDeficitFundValueUSDMV</Name>
                <Display>Base Policy Deficit Fund Value</Display>
                <DataType>Money</DataType>
            </Field>
        </Fields>
    </PolicyValues>
    <FundDetails>
        <Include>
            <Fund>Interim Holding Fund</Fund>
            <Fund>Fixed Term Fund</Fund>
            <Fund>Indexed Strategy I</Fund>
            <Fund>Indexed Strategy II</Fund>
            <Fund>Loan Credit (Standard)</Fund>
            <Fund>Loan Credit (Preferred)</Fund>
        </Include>
        <Columns>
            <Column ALIGN="RIGHT">
                <Name>Units</Name>
                <Display>Units</Display>
                <DataType>Units</DataType>
            </Column>
            <Column ALIGN="RIGHT">
                <Name>UnitValue</Name>
                <Display>Unit Value</Display>
                <DataType>Money</DataType>
            </Column>
        </Columns>
    </FundDetails>
    <Graphs ALLOCATIONS="No" ASSETS="Yes"/>
</ValuesScreen>